<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="Wave,com.nextgenapp.wave.gadget.Wave,getHost,getParticipantById,getParticipants,getState,getTime,getViewer,isInWaveContainer,isPlayback,setParticipantCallback,setStateCallback,submitDelta" name="keywords">
<title>com.nextgenapp.wave.gadget.Wave</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'Wave - API Documentation';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?com/nextgenapp/wave/gadget/Wave.html&amp;com/nextgenapp/wave/gadget/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;Wave</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class Wave"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.nextgenapp.wave.gadget</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Wave</td>
</tr>
</table>
<p></p>
  Main starting point.
  
  <p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#Wave()">Wave</a>(... domains)</div>
<div class="summaryTableDescription">
   </div>
</td><td class="summaryTableOwnerCol">Wave</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getHost()">getHost</a>():<a href="../gadget/WaveParticipant.html">WaveParticipant</a>
</div>
<div class="summaryTableDescription">
   Get host, participant who added this gadget to the blip.</div>
</td><td class="summaryTableOwnerCol">Wave</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getParticipantById()">getParticipantById</a>(id:String):<a href="../gadget/WaveParticipant.html">WaveParticipant</a>
</div>
<div class="summaryTableDescription">
   Returns a Participant with the given id.</div>
</td><td class="summaryTableOwnerCol">Wave</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getParticipants()">getParticipants</a>():Array</div>
<div class="summaryTableDescription">
   Returns a list of participants on the Wave.</div>
</td><td class="summaryTableOwnerCol">Wave</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getState()">getState</a>():<a href="../gadget/WaveState.html">WaveState</a>
</div>
<div class="summaryTableDescription">
   Returns the gadget state object.</div>
</td><td class="summaryTableOwnerCol">Wave</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getTime()">getTime</a>():Number</div>
<div class="summaryTableDescription">
   Retrieves "gadget time" which is either the playback frame time in the playback mode or the current time otherwise.</div>
</td><td class="summaryTableOwnerCol">Wave</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getViewer()">getViewer</a>():<a href="../gadget/WaveParticipant.html">WaveParticipant</a>
</div>
<div class="summaryTableDescription"> 
   Get the participant whose client renders this gadget.</div>
</td><td class="summaryTableOwnerCol">Wave</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#isInWaveContainer()">isInWaveContainer</a>():Boolean</div>
<div class="summaryTableDescription">
   call wave.isInWaveContainer() on js.</div>
</td><td class="summaryTableOwnerCol">Wave</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#isPlayback()">isPlayback</a>():Boolean</div>
<div class="summaryTableDescription">
   Returns the playback state of the wave/wavelet/gadget.</div>
</td><td class="summaryTableOwnerCol">Wave</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setParticipantCallback()">setParticipantCallback</a>(callback:Function, opt_context:Object = null):void</div>
<div class="summaryTableDescription">
   Sets the participant update callback.</div>
</td><td class="summaryTableOwnerCol">Wave</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setStateCallback()">setStateCallback</a>(callback:Function, opt_context:Object = null):void</div>
<div class="summaryTableDescription">
   Sets the gadget state update callback.</div>
</td><td class="summaryTableOwnerCol">Wave</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#submitDelta()">submitDelta</a>(delta:Object):void</div>
<div class="summaryTableDescription">
   this method is in State object on JS API.</div>
</td><td class="summaryTableOwnerCol">Wave</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="Wave()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">Wave</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function Wave(... domains)</code><p>
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code>... <span class="label">domains</span></code> &mdash; — One or more strings or URLRequest objects that name the domains from which you want to allow access. You can specify the special domain " to allow access from all domains.
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="getHost()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getHost</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function getHost():<a href="../gadget/WaveParticipant.html">WaveParticipant</a></code><p>
   Get host, participant who added this gadget to the blip. 
   Note that the host may no longer be in the participant list.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../gadget/WaveParticipant.html">WaveParticipant</a></code> &mdash; 
                        host (null if not known)
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getParticipantById()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getParticipantById</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getParticipantById(id:String):<a href="../gadget/WaveParticipant.html">WaveParticipant</a></code><p>
   Returns a Participant with the given id.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">id</span>:String</code> &mdash;  The id of the participant to retrieve.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../gadget/WaveParticipant.html">WaveParticipant</a></code> &mdash; 
                        The participant with the given id.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getParticipants()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getParticipants</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getParticipants():Array</code><p>
   Returns a list of participants on the Wave.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Array</code> &mdash; Participant list
   </td>
</tr>
</table>
</div>
<a name="getState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getState():<a href="../gadget/WaveState.html">WaveState</a></code><p>
   Returns the gadget state object.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../gadget/WaveState.html">WaveState</a></code> &mdash; 
                          gadget state (null if not known)
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getTime()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getTime</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getTime():Number</code><p>
   Retrieves "gadget time" which is either the playback frame time in the playback mode or the current time otherwise.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Number</code> &mdash; The gadget time.
   </td>
</tr>
</table>
</div>
<a name="getViewer()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getViewer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getViewer():<a href="../gadget/WaveParticipant.html">WaveParticipant</a></code><p> 
   Get the participant whose client renders this gadget.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../gadget/WaveParticipant.html">WaveParticipant</a></code> &mdash; 
                        the viewer (null if not known)
   
                        
                     </td>
</tr>
</table>
</div>
<a name="isInWaveContainer()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">isInWaveContainer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function isInWaveContainer():Boolean</code><p>
   call wave.isInWaveContainer() on js.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code></td>
</tr>
</table>
</div>
<a name="isPlayback()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">isPlayback</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function isPlayback():Boolean</code><p>
   Returns the playback state of the wave/wavelet/gadget.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; whether the gadget should be in the playback state
   </td>
</tr>
</table>
</div>
<a name="setParticipantCallback()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setParticipantCallback</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setParticipantCallback(callback:Function, opt_context:Object = null):void</code><p>
   Sets the participant update callback. If the participant information is already received, the callback is invoked immediately to report the current participant information. Only one callback can be defined. Consecutive calls would remove old callback and set the new one.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">opt_context</span>:Object</code> (default = <code>null</code>)<code></code> &mdash;  the object that receives the callback
   </td>
</tr>
</table>
</div>
<a name="setStateCallback()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setStateCallback</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setStateCallback(callback:Function, opt_context:Object = null):void</code><p>
   Sets the gadget state update callback. 
   If the state is already received from the container, 
   the callback is invoked immediately to report the current gadget state. 
   Only one callback can be defined. 
   Consecutive calls would remove the old callback and set the new one.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">callback</span>:Function</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">opt_context</span>:Object</code> (default = <code>null</code>)<code></code> &mdash;  the object that receives the callback
   </td>
</tr>
</table>
</div>
<a name="submitDelta()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">submitDelta</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function submitDelta(delta:Object):void</code><p>
   this method is in State object on JS API.  However, since there is only one single state, and 
   we have to call wave.getState().submitDelta(), it is better to put this method here.
   
   WaveState.submitDelta() is deprecated.  
   Updates the state delta. This is an asynchronous call that will update the state and not take effect immediately. Creating any key with a null value will attempt to delete the key.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">delta</span>:Object</code> &mdash;  Map of key-value pairs representing a delta of keys to update.
   </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
